Devices > Remote Devices > Device Template Files > Elements and Attributes > RecParmName, SendParmName

RecParmName, SendParmName

RecParmName and SendParmName elements define the get and send parameters for a data group. RecParmName and SendParmName are placeholder tags for an actual receive or send parameter; replace their tag text with the protocol- or user-defined ID. Most receive parameter and send parameter names are defined by specific protocols. However, some device template files (for example, Modbus) allow the addition of user-defined names. The RecParmName or SendParmName can be a maximum of 10 characters. Valid characters are A-Z, 0-9, dash (-), and underscore (_). RecParmName and SendParmName cannot contain spaces and must start with an alphabetical character.

These elements are:

To learn about how this element relates to other elements in a CygNet device template file, see Template File Hierarchy.

Example

ClosedClick here to see an example of the element

 

<SnglRegRw niceName="Single Read/Write Register" dgCat="singleReg" canSend="true" uccSend="true" forceSave="true">

<dgElements byteOrder="bigEndian" secLev="4">

<RegNum desc="Register Number" type="ui2"/>

<DataType desc="Data Type" type="string"/>

<FacUdc desc="Facility.UDC for Point Processing" type="string"/>

<Value desc="Data Value" type="vrnt"/>

</dgElements>

<modbusReadBlocks>

<block1 regOff="-40001" regNum="40001" regByteLen="2" regCnt="1" funcCode="3"/>

</modbusReadBlocks>

<modbusWriteBlocks>

<block1 regOff="-40001" regNum="40001" regByteLen="2" regCnt="1" funcCode="6"/>

</modbusWriteBlocks>

<uccRecvParms type="string">

<RegNum desc="Register Number" required="true" type="ui2"/>

<DataType desc="Data Type" required="true" type="string"/>

<FacUdc desc="Facility.UDC for Point Processing" required="false" type="string"/>

</uccRecvParms>

<uccSendParms>

<RegNum desc="Register Number" required="true" type="ui2"/>

<Value desc="Value" required="true"/>

<DataType desc="Data Type" required="true" type="string"/>

<FacUdc desc="Facility.UDC for Point Processing" required="false" type="string"/>

</uccSendParms>

</SnglRegRw>

See also: the Single-Element Data Group topic for your device type.

Attributes

The following table lists and describes attributes generally applicable to this element. However, not all of the attributes listed here are applicable to all EIEs. Additionally, some attributes are required for use in every device template file of a certain EIE, but others may be used on a case-by-case or device-by-device basis, depending on your specific needs. All attributes in templates are case sensitive; but the case sensitivity of attribute values is based on context.

Note: Occasionally, device template files for different EIEs use attributes of the same name that do different things. Efforts are made in this document to highlight cases where an attribute by one name does different things in different EIEs.

Attribute Description

desc

desc is the user-defined description of a data group element, typically used as a name or title. Depending on implementation, sometimes this attribute's value appears in remote device editors and sometimes it does not.

Value
  • User-defined string, no character limit.

required

required specifies whether or not a parameter is required.

Value:
  • Must be a Boolean value true or false.

type

type defines the appropriate data type for one or more DataGroupElement elements; it can be inherited from a parent element.

Value:
  • bin.hex: Binary hex
  • boolean: Boolean
  • i1: Character
  • i2: Short integer
  • i4: Integer
  • i8: Integer
  • r4: Float
  • r8: Double
  • ui1: Byte
  • ui2: Unsigned short integer
  • ui4: Unsigned integer
  • ui8: Unsigned integer
  • string: String
  • struct: Structure

See also sourceType.
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.